home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Cream of the Crop 1
/
Cream of the Crop 1.iso
/
UTILITY
/
OBSKIT.ARJ
/
QUIKSTRT.DOC
< prev
next >
Wrap
Text File
|
1992-01-11
|
21KB
|
528 lines
Obs Toolkit Version 1.5
Contrails, Inc.
P.O. Box 2759
Lompoc, CA 93438
(805) 733-2808
Introduction
------------
Welcome to Obs Toolkit. We thank you for your interest. The OBSKIT.DOC is
a large file with a all of the detailed information. We recommend that
you read it. This file is provided to get you up and running with a
minimum of hassel.
The information in this file, should introduce you to the Toolkit, and
get you interested in no time.
Obs Toolkit requires DOS 3.0 or higher and 256Kb of memory. Obs Toolkit
is complementary to all versions of DOS including DOS 5.
Overview
--------
This guide is structured to describe the tools; give you a taste of the
Toolkits capabilities and describe some terms and interfaces.
Supplied Files
--------------
The files that make up Obs Tools are:
o ALIAS.EXE - Alias, the alias generator
o DIRSTACK.COM - A directory stack without Alias translator
o DS.EXE - DirSize, a tree with sizes
o EE.EXE - EnvEdit, a DOS environment editor
o FD.EXE - FileDump, the file viewer
o LF.EXE - ListFiles, the file lister
o LOCATE.EXE - Locate, the executable command and file locator
o MF.EXE - MultiFile, the file manipulator
o OBSRES.COM - Alias translator, dictionary, and directory stack
o OCD.EXE - ObsCD, a super-intelligent Change Directory
o RERES.COM - Recapture the command line
The files with alias definitions are:
o ALIASES.DOS - Replaces DOS internal commands
o ALIASES.REC - A comprehensive set of recursive aliases
o xDOS.CFG - Aliases for NDOS and 4DOS users
o PCED.CFG - Aliases for PCED users
o CMD_ED.CFG - Aliases for CMDEDIT users
Support files are:
o INSTALL.BAT - Automatic installation into your AUTOEXEC.BAT
o TRYIT.BAT - Quick Start batch file, to get you up and running
o OBSKIT.DOC - Obs Toolkit users manual
o QUIKSTRT.DOC - This file (introduction, orientation, quick start)
o README.DOC - Startup advice
o REGISTER.DOC - Registration form
o UPDATES.DOC - Changes since version 1.0
o UPGRADE.DOC - Notes for users of version 1.0
Toolkit Capabilities
--------------------
The Toolkits sole purpose is to give you, the user, POWER! No, it won't
generate electricity, but it will allow you to do things at the command
line, or in batch files, that were never before possible.
Obs Toolkit can be used to generate your own commands! Obs Toolkit can
provide custom commands, like (this is by no means an exhaustive set):
o ALIAS (define your own commands)
o ATTRIB (set and/or clear any DOS attributes)
o CD (fuzzy matching, across disks, push, pop, up)
o COPY (add, update, replace, add & update, archive only)
o DELETE (files, directories with contents)
o DIR (any sort, duplicates, old files, identical contents)
o LOCATE (commands, files, multiple disks)
o MOVE (between directories, across disks, whole directories)
o RENAME (files, directories)
o SET (any environment, editor, long variables, batchable)
o TOUCH (set file date and time to any valid timestamp)
o TREE (with directory sizes, creation dates)
o TYPE (ASCII only, HEX dump, strings, counts, multiple files)
Obs Toolkit can be used within batch files. Each tool returns an
errorlevel, and a few tools have options specifically tailored for batch
use.
The errorlevels generated are:
0 - NO ERROR - No error encountered
1 - NOT FOUND - File or object was "NOT FOUND"
2 - ABORTED - The user chose to "ABORT" the operation
3 - OPERATION FAILED - The requested "OPERATION FAILED"
4 - LIMIT EXCEEDED - The operation exceeded the tools "LIMIT"
5 - USAGE ERROR - The tool displayed a "USAGE" error
6 - INSTALL FAILED - The tool was unable to "INSTALL"
Quick Installation
------------------
A quick installation patch is provided so that trying out the Toolkit is
completely painless. This is a description of that installation process:
The way to get started running Obs Toolkit right now, is to move to the
directory where the Toolkit is located and type:
C> TRYIT
NOTE: NDOS and 4DOS users
OBSRES will not be able to swap the command line. You should use the
XDOS.CFG file. Instead of installing OBSRES install only a DirStack
using DIRSTACK 9 to minimize the memory consumption.
TRYIT.BAT will only map the existing DOS commands to Toolkit equivalents.
The Toolkit has much more power than what is shown below. The TRYIT.BAT
is just providing a taste.
~~~~~
Replaced Commands
-----------------
Obs Toolkit will be installed into memory (takes up 3K RAM) and will
supplant the following DOS commands:
o CD, CHDIR - mapped to ObsCD (OCD)
o COPY - mapped to MultiFile (MF)
o DEL, ERASE - mapped to MultiFile (MF)
o DIR - mapped to ListFiles (LF)
o MD, MKDIR - mapped to ObsCD (OCD)
o PATH - mapped to EnvEdit (EE)
o PROMPT - mapped to EnvEdit (EE)
o RD, RMDIR - mapped to ObsCD (OCD)
o REN, RENAME - mapped to MultiFile (MF)
o SET - mapped to EnvEdit (EE)
o TYPE - mapped to FileDump (FD)
Building a HotDir file
----------------------
To enable HotDir support for changing directories type:
C> OCD /READ
This will scan all disks and remember the locations of all directories.
If you have RAM disks, network drives, or any directories that you don't
want to include in the HotDir file, then refer to the Users Manual for
the commands to tailor the HotDir file to your liking. ObsCD is real
agreeable.
Turning the Toolkit ON and OFF
------------------------------
When you run TRYIT.BAT the Toolkit is ON. You can switch the Toolkit ON
and OFF by using the DOT COMMANDS (.command) at the DOS prompt.
The .COMMANDS available are:
.ON - Turn the Toolkit ON
.OFf - Turn the Toolkit OFF
.Echo - Display ALIAS translations
.Noecho - Do not display ALIAS translations
You can also skip an alias translation by prefixing the command with a
space (ALIAS can change the Skip Character):
C>DIR (uses the alias)
C> DIR (uses DOS)
Persistent Installation
-----------------------
This installation will modify your AUTOEXEC.BAT file so that the Toolkit
interface will be available each time you boot your computer.
The commands provided are documented in the ALIASES.REC file.
A new file will be created in the Toolkit directory (ALIASES.FIL) which
contains the aliases from ALIASES.REC and has the OB alias defined.
The AUTOEXEC.BAT file will be modified (appended to) to contain:
[obs_path]\OBSRES
[obs_path]\ALIAS /FILE [obs_path]\ALIASES.FIL
To perform the persistent installation you must:
1) Change to the directory where the Toolkit is located
2) Type "INSTALL" at the command line
INSTALL.BAT is providing you with a full seven course meal!
~~~~~ ~~~~~~ ~~~~
If you haven't already done a HotDir scan (OCD /READ) and you want OCD
HotDir support then refer to the section "Building a HotDir File" above.
You may want to edit your AUTOEXEC.BAT file to add the Toolkit directory
to your path (this is required for batch file support unless you use
fully qualified filenames).
If your AUTOEXEC.BAT launches a menu program (or Windows) you must
manually move the two Toolkit commands before the menu program commands
or the Toolkit interface will not be available until after you exit the
menu program.
Using Obs Toolkit
-----------------
Getting Help
------------
All of Obs Tools have embedded help screens. To access the help screen
just type /? after the program name. (e.g., OCD /?)
WildSpecs
---------
WildSpecs are a superset of the DOS wildcards. They are used the same,
except that '*'s can be used anywhere within a file specification, and
'?'s stand for a single character that is required.
? - matches any single character (a character is required)
* - matches any group of characters (zero or more characters may match)
Now you can do things like
C>DIR *test*.* (directory of all files with TEST embedded somwhere in
the file name).
SmartPaths
----------
SmartPaths are directories on the DirStack that you can access as if they
were DOS drives. Create SmartPaths using OCD /PUSH. Access SmartPaths by
using 1: - 9:.
OCD /LIST (Reports contents of DirStack)
SmartPaths work just like regular drives. You can also OCD /POP back.
You use SmartPaths by typing the SmartPath number instead of the drive
letter.
C>DIR 1:*.exe or
C>COPY test.bat 2:
Date and Time
-------------
"Date Time" (Quotes required to supply both Date & Time)
date = mm-dd-yy - The full date must be specified
date = -days - That many days in the past
time = hh:mm:ss - The minutes & seconds are optional
time = . - This translates to the current time
Line Editor
-----------
Up Arrow Move one line up (multiple line display only)
Down Arrow Move one line down (multiple line display only)
Left Arrow Move one character to the left
Right Arrow Move one character to the right
CTRL-Left Move one word to the left
CTRL-Right Move one word to the right
INSERT Toggle Insert/Overstrike mode
HOME (^A) Move to the beginning of the edit field
END (^E) Move to the end of the edit field
DELETE (^D) Delete the current character
BACKSPACE Delete the previous character
CTRL-Y Delete the entire line
RETURN (ALT-X) Store changes and exit
ESCAPE Abort changes and exit
The line editor is built into the Environment Editor and Alias. You bring
up the editor by using the /EDIT qualifier.
To edit your PATH you can type:
C>EE /EDIT PATH
Scrolling
---------
Obs tools all support display paging, so that the text does not scroll
off the screen before you have a chance to read it.
Paging can be activated by using the tools /PAGE switch.
You can enter and exit paging mode interactively, by pressing <escape>.
Printing OBSKIT.DOC
-------------------
The following procedure should be used to print OBSKIT.DOC:
1) Turn on your printer
2) Type COPY OBSKIT.DOC PRN
3) Get a cup of Java (it will take a short while)
Quick Reference
---------------
------------------------------------------------------------------------
Alias
------------------------------------------------------------------------
Usage:
alias [/[NO]Page] [name] - Report synonym(s) (wildspecs supported)
alias [/NOSpace] name cmd - Define synonym (abbreviate using "'")
alias /NUll name - Define null synonym
alias /Make name - Define a path alias
alias /EDit name - Edit alias definition
alias /CLear - Remove ALL synonyms
alias /Delete name - Remove synonym
alias /File file.ext - Read alias commands from file.ext
alias [options] - (configures/info on the translator; may be combined)
/[NO]CAse - Case sensitive aliases
/[NO]ECho - Echo translations
/[NO]Recurse - Recursively apply aliases
/OFf - Turn translator Off
/ON - Turn translator On
/STatus - Report active conditions
/SKipchar x - Define character to skip translation
------------------------------------------------------------------------
DirSize
------------------------------------------------------------------------
Usage: DS [options] [path]
Options are:
/BYDAte - Sort tree in date order
/BYDOs * No tree sort
/BYName - Sort tree in alphabetical order
/BYSize - Sort tree from smallest to largest
/DEpth num - Draw tree to depth 'num'
/[NO]Count - Continue to count files
/[NO]DAte - Display creation date
/[NO]Page - Page output
/[NO]Size + Display sizes
------------------------------------------------------------------------
EnvEdit
------------------------------------------------------------------------
Usage: EE [options] [variable[=[definition]]]
Options are:
/CUrrent - Use the Current environment
/DOs * Use the active DOS environment
/MASter - Use the Master environment (aka /ROot)
/Parent - Use the Parent environment
/[NO]CAse - Name is case sensitive
/[NO]Edit - Permits usage of the line editor
/[NO]STatus - Report status on the environment
/[NO]REMove + Remove variable on "VAR="
/[NO]Quiet - No display output
/Append - Append "text" to end of definition
/INSert - Insert "text" to beginning of definition
/REPlace - Replace "text_1" with "text_2" in definition
/COpy - Duplicate environment variable
/DELete - Delete environment variable
/MAKe - Define a variable to be the current directory
/REName - Rename environment variable
/INCrement - Add one to the variable
/DECrement - Subtract one from the variable
/Upper - Change definition to all upper case
/LOWer - Change definition to all lower case
/CLear - Clear the environment
/LOAd - Load DOS environment from file
/SAve - Store environment into file
------------------------------------------------------------------------
FileDump
------------------------------------------------------------------------
Usage: FD [options] {[SmartPath][directory]WildSpec}
Options are:
/Ascii - Ascii output
/COUnt - Count chars, words, lines, and pages
/Hex - Hex output
/TExt * Text output
/STrings # - String output (# is minimum string length)
/BInary - Force input to be binary
/BEgin #[x] - Start offset
/End #[x] - End offset
/TAb # - Set tab setting (normally 8)
/7 - Strip high bit
/8 * Do not strip high bit
/[NO]COMpress - Compress runs
/[NO]NUmber - Number lines (/TEXT only)
/[NO]Page - Page output
/[NO]SMart - Smart type logic
/[NO]Wrap + Wrap long lines
------------------------------------------------------------------------
ListFiles
------------------------------------------------------------------------
Usage: LF [options] [SmartPath][directory]{WildSpec}
Options are: (/-x for B C G L O P R W X)
1 - 12 hour clock; 2 - 24 hour clock
Ax - Attribute
A - Archive, H - Hidden, R - Read-only, S - System, D - Directory
+ - include, - - exclude, * - required
Bx - Brief output (B+ for full pathnames)
Cx - Command listing (B - Beginning, E - End, T - Text)
Dx - Detect special conditions
C - duplicate Contents D - Duplicate entry,
H - Hidden programs O - Old files
G - report Grand total information only
L - Lower case
Ox - Order by (-x to reverse)
U - Unsorted, E - by Extension, N - by Name, G - Group directories
S - by Size, D - by Date/time, R - Reverse output
P - Page output
R - Recurse Sub-directories
Sx - Size restriction (L - Less-than, E - Equal, G - Greater than)
Tx - Time restriction (B - Before, E - Exact, S - Since)
Wx - Wide output (x is number of columns (1-5))
Xx - Exclude WildSpec (may be repeated)
------------------------------------------------------------------------
Locate
------------------------------------------------------------------------
Usage: LOCATE [options] {disk} [name]
Options are:
/COmmand * Search for a command
/FIle - Search for a file
/[NO]All - Include system and hidden files (/File only)
/[NO]CHange - Change to directory where /COMMAND was found
/[NO]FUll - Display all file information for commands
/[NO]Page - Page output
/[NO]Wide - Wide output
------------------------------------------------------------------------
MultiFile
------------------------------------------------------------------------
Usage: MF [options] [SmartPath]WildSpec [SmartPath][filespec]
Options are: (-x cancels ! H I F P N Q R V X Y)
C - Copy all files CU - Update existing files
CR - Replace existing files CA - Add new files
CAR - Add & Replace (like DOS) CUA - Update & Add
D - Delete M - Move/Rename
SAx - Set Attributes STx - Set file date & Time
Ax - Attribute selection
A - archive, H - hidden, R - read-only, S - system
+ - include, - - exclude, * - required
I - Ignore overwrites by skipping file
N - Select archive files, reset after copy (copy only)
Tx - Time restrictions (B - Before, E - Exact, S - Since)
Xx - Exclude WildSpec (may be repeated)
! - Test run, perform no actions H - Hoist to target / flatten tree
F - Force all operations P - Prompt at each file
Q - Quiet operations R - Recurse Sub-directories
V - Verify writes Y - Yes to cautions
------------------------------------------------------------------------
ObsCD
------------------------------------------------------------------------
Usage: OCD [options] [SmartPath][dirname]
Options are:
/LIst - List the DirStack and default dirs
/MKdir - Make directory (MD)
/POp [n] - Restores a pushed location (default=1)
/REad - Read a new HotDir file
/RMdir - Remove directory (RD)
/STack - Put the specified directory on the DirStack
/UP [n] - Moves up 'n' directories (default=1)
/DRives - Drives to /READ or /LIST
/LAst - Last drive to scan during /READ or /LIST
/eXclude - Exclude directory from /READ
/Basedisk - Lowest hard drive letter (default 'C:')
/[NO]Change - Change into directory during /MKDIR
/[NO]DIsk - Allows disk changes
/[NO]ECho - Reports directory changed to
/[NO]Force - Force push (no duplicate check)
/[NO]PUsh - Saves current location to the DirStack
/[NO]SCan - Force scan for directory change
/[NO]UPDate + OK to update the HotDir file
Shareware
---------
Obs Toolkit is distributed as Shareware. This is a Shareware copy that
you are entitled to use and evaluate. If you would like to continue using
this Toolkit after a reasonable evaluation period, then you must register
the Toolkit with Contrails, Inc.
A license is required to use Obs Toolkit in corporations or institutions.
Registration information is contained in the Users Manual OBSKIT.DOC, and
in the registration form REGISTER.DOC.
Registration is only $39.00.
ASP Ombudsman
-------------
This program is produced by a member of the Association of Shareware
Professionals (ASP). ASP wants to make sure that the shareware principle
works for you. If you are unable to resolve a shareware-related problem
with an ASP member by contacting the member directly, ASP may be able to
help. The ASP Ombudsman can help you resolve a dispute or problem with an
ASP member, but does not provide technical support for members' products.
Please write to the ASP Ombudsman at 545 Grover Road, Muskegon, MI 49442-
9427 or send a Compuserve message via CompuServe Mail to ASP Ombudsman
70007,3536"